home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 1 Issue 2 / PDCD-1 - Issue 02.iso / _utilities / utilities / 003 / bulktext / !BulkJoin / !Help next >
Text File  |  1994-05-03  |  5KB  |  138 lines
  1. BulkJoin -  pack ASCII files into single "BulkText" file
  2. -------------------------------------------------------
  3.  
  4. This utility will combine a number of individual ASCII
  5. files together into a single "BulkText" file. This file
  6. can then itself be packed into a ZIP or similar archive.
  7. The advantage of combining the small files first, is
  8. that this is much quicker and the final archive file is
  9. smaller. A single file is also much more convenient for
  10. uploading to a mainframe. The corresponding BulkSplit
  11. utility will unpack the "BulkText" file again,
  12. recreating the original files.
  13.  
  14. BulkJoin also converts newline characters encountered in
  15. the input into DOS CRLF characters.
  16.  
  17. BulkJoin should only be used to combine ASCII files.
  18. Results are unpredictable if it is used on binary files.
  19.  
  20. How to use BulkJoin
  21. -------------------
  22. Install the BulkJoin icon on the icon bar in the usual
  23. way. Click select once on the icon to open the setup
  24. dialog box. Drag the input directory(ies) and/or file(s)
  25. to the box labelled "Input" and select/deselect the
  26. recursive processing of subdirectories via the option
  27. button. Then click on the "Run" button to begin
  28. processing.
  29.  
  30. When BulkJoin has finished, a save box will be displayed
  31. allowing you to drag the output file to your destination
  32. of choice. By default, the output file name will be
  33. "BulkText".
  34.  
  35. Using BulkJoin from the Command line
  36. ------------------------------------
  37. BulkJoin can also be used from the command line (or more
  38. likely, from within command scripts).
  39.  
  40. Syntax:  *BulkJoin  [path.]object [[path.]object ...]
  41.                     -o [path.]file [options]
  42.  
  43. The arguments consist of one or more arguments
  44. specifying the input files (any number are allowed),
  45. followed by the output file specification plus optional
  46. processing options.
  47.  
  48. object:  Specifies the input text file(s) as one of the
  49.          following:
  50.          (a) a non-wildcarded file name
  51.          (b) a non-wildcarded directory name
  52.          (c) a wildcarded name.
  53.  
  54.          In case (a) the file is copied/added to the
  55.          output file.
  56.  
  57.          In case (b) all files in the specified
  58.          directory are copied/added to the output file.
  59.          If the RECURSION option is specified, all files
  60.          in all subdirectories are also processed.
  61.  
  62.          In case (c) all matching files are copied/added
  63.          to the output file. If no matching files are
  64.          found, then the first matching directory name
  65.          is taken and all files therein are
  66.          copied/added. If the RECURSION option is
  67.          specified, all matching files are copied/added,
  68.          plus all files in all matching subdirectories.
  69.  
  70. file:    Specifies the non-wildcarded output file name.
  71.  
  72. path:    Specifies the directory to be searched for the
  73.          file/directory described above. If omitted the
  74.          current directory is searched.
  75.  
  76. options: Specifies processing options which can be one or
  77.          more of the following:
  78.  
  79.          -a - ADD mode; input files will be added to the
  80.               end of an existing output file. Otherwise
  81.               any existing output file will be
  82.               overwritten.
  83.  
  84.          -r - RECURSION mode which causes all eligible
  85.               files in all subdirectories to be
  86.               copied/added.
  87.  
  88.          -t - TEST mode; a list of files to be
  89.               copied/added is displayed but no output
  90.               file is actually created; useful for
  91.               checking when specifying a directory or
  92.               wildcarded filename as input.
  93.  
  94. Example:
  95.  
  96.      *BulkJoin adfs::4.$.source -o adfs::4.$.bulksource -r
  97.  
  98. Technical information
  99. ---------------------
  100. Bulkjoin inserts a special marker between the individual
  101. files that it packs into the output file. This marker
  102. has the format:
  103.  
  104.      @@@@---> filename
  105.  
  106. In the (unlikely) event that this combination of
  107. characters occured at the beginning of a line in one of
  108. the files being processed, the associated BulkSplit
  109. application would treat it incorrectly as the start of a
  110. file.
  111.  
  112. BulkJoin was written in C and compiled with the
  113. AcornSoft ANSI C Compiler Version 4. It requires the
  114. Acorn Floating Pointer Emulator and Shared C Library
  115. relocatable modules to be installed. The !BulkJoin
  116. application runs under the Acorn DDE environment.
  117.  
  118. Copyright notice
  119. ----------------
  120. BulkJoin is FREEWARE. The copyright remains with Paul
  121. Witheridge.
  122.  
  123. Permission is granted by the author to any recipient of
  124. this material to use and make/disseminate copies of the
  125. application provided that no charges are made for doing
  126. so except (a) to cover any cost of media or postage, or
  127. (b) nominal fees levied by public domain libraries, and
  128. that this notice is included with all copies.
  129.  
  130. Paul Witheridge
  131. 1 Ragmans Close
  132. Marlow Bottom
  133. Marlow
  134. Bucks
  135. SL7 3QW
  136.  
  137. 27 July 1993
  138.